An Overview of Industrial Software Documentation Practices
نویسنده
چکیده
A system documentation process maturity model and assessment procedure were developed and used to assess 91 projects at 41 different companies over a seven year period. During this time the original version evolved into a total of four versions based on feedback from industry and the experience gained from the assessments. This paper reports the overall results obtained from the assessments which strongly suggest that the practice of documentation is not getting a passing grade in the software industry. The results show a clear maturity gap between documentation practices concerned with defining policy and practices concerned with adherence to those policies. The results further illustrate the need to recognize the importance of improving the documentation process, and to transform the good intentions into explicit policies and actions.
منابع مشابه
Re-engineering Issues and Opportunities in XP key adaptive practices
Legacy software must often be reengineered, a process that involves both reverse and forward engineering. No doubt, there is a lack of resource requirements, design, or design rationale documentation for legacy software. This lack of resource requirement means an unavailability of traces as well, making reengineering difficult and expensive. In this paper we arise the reengineering task and the...
متن کاملAn Empirical Study on Integrating Agile and User Centered Design
This paper discusses an empirical study that identified challenges exhibited by industrial practitioners in integrating Agile development processes and User Centred Design (UCD). The study also identified practices utilised in order to achieve the integration. Fourteen in-depth, one-to-one interviews were conducted with 14 participants from 11 companies of varying sizes in five different countr...
متن کاملA Practitioner Perspective on Integrating Agile and User Centred Design
This paper discusses an empirical study that identified challenges exhibited by industrial practitioners in integrating Agile development processes and User Centred Design (UCD). The study also identified practices utilised in order to achieve the integration. Fourteen in-depth, one-to-one interviews were conducted with 14 participants from 11 companies of varying sizes in five different countr...
متن کاملPractices of Software Maintenance
This paper describes the results of an interview study conducted at ten industrial sites. The interview focused on the work practices of software engineers engaged in maintaining large scale systems. Five ‘truths’ emerged from this study. First, software maintenance engineers are experts in the systems they are maintaining. Second, source code is the primary source of information about systems....
متن کاملEarly Stage Adoption of ISO/IEC 29110 Software Project Management Practices: A Case Study
The ISO/IEC 29110 standard has at its core a Management and Engineering Guide [1] which are targeted at very small entities (enterprises, organizations, departments or projects) having up to 25 people [2], to assist them unlock the potential benefits of using standards which are specifically designed to address their needs. This paper discusses the role and structure of Project Management in th...
متن کامل